home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmImMbLookupString.z / XmImMbLookupString
Text File  |  1998-10-30  |  7KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmIIIImmmmMMMMbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmIIIImmmmMMMMbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmIIIImmmmMMMMbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg - An input manager function that
  10.           retrieves a composed string from an input method
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/XmIm.h>
  14.           iiiinnnntttt XXXXmmmmIIIImmmmMMMMbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg(
  15.           WWWWiiiiddddggggeeeetttt wwwwiiiiddddggggeeeetttt,
  16.           XXXXKKKKeeeeyyyyPPPPrrrreeeesssssssseeeeddddEEEEvvvveeeennnntttt ****eeeevvvveeeennnntttt,
  17.           cccchhhhaaaarrrr ****bbbbuuuuffffffffeeeerrrr____rrrreeeettttuuuurrrrnnnn,
  18.           iiiinnnntttt bbbbyyyytttteeeessss____bbbbuuuuffffffffeeeerrrr,
  19.           KKKKeeeeyyyySSSSyyyymmmm ****kkkkeeeeyyyyssssyyyymmmm____rrrreeeettttuuuurrrrnnnn,
  20.           iiiinnnntttt ****ssssttttaaaattttuuuussss____rrrreeeettttuuuurrrrnnnn);
  21.  
  22.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  23.           This page documents Motif 2.1.
  24.  
  25.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.           XXXXmmmmIIIImmmmMMMMbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg returns a string composed in the locale
  27.           associated with the widget's input method and a KeySym that
  28.           is currently mapped to the keycode in a KeyPress event. The
  29.           KeySym is obtained by using the standard interpretation of
  30.           Shift, Lock and Group modifiers as defined in the X Protocol
  31.           specification.
  32.  
  33.           An XIM will be created, but an XIC will not be created. One
  34.           of the functions, XXXXmmmmIIIImmmmSSSSeeeettttVVVVaaaalllluuuueeeessss, XXXXmmmmIIIImmmmVVVVaaaaSSSSeeeettttVVVVaaaalllluuuueeeessss, or
  35.           XXXXmmmmIIIImmmmGGGGeeeettttXXXXIIIICCCC, needs to be called to create an XIC.
  36.  
  37.           _w_i_d_g_e_t    Specifies the ID of the widget registered with the
  38.                     input manager
  39.  
  40.           _e_v_e_n_t     Specifies the key press event
  41.  
  42.           _b_u_f_f_e_r__r_e_t_u_r_n
  43.                     Specifies the buffer in which the string is
  44.                     returned
  45.  
  46.           _b_y_t_e_s__b_u_f_f_e_r
  47.                     Specifies the size of the buffer in bytes
  48.  
  49.           _k_e_y_s_y_m__r_e_t_u_r_n
  50.                     Specifies a pointer to the KeySym returned if one
  51.                     exists
  52.  
  53.           _s_t_a_t_u_s__r_e_t_u_r_n
  54.                     Specifies the status values returned by the
  55.                     function. These status values are the same as
  56.                     those for the XXXXmmmmbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg function. The
  57.                     possible status values are:
  58.  
  59.                     XXXXBBBBuuuuffffffffeeeerrrrOOOOvvvveeeerrrrfffflllloooowwww
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmIIIImmmmMMMMbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmIIIImmmmMMMMbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                               The size of the buffer was insufficient
  75.                               to handle the returned string. The
  76.                               contents of _b_u_f_f_e_r__r_e_t_u_r_nand
  77.                               _k_e_y_s_y_m__r_e_t_u_r_n are not modified. The
  78.                               required buffer size is returned as a
  79.                               value of the function. The client should
  80.                               repeat the call with a larger buffer
  81.                               size to receive the string.
  82.  
  83.                     XXXXLLLLooooooookkkkuuuuppppNNNNoooonnnneeee
  84.                               No consistent input was composed. The
  85.                               contents of _b_u_f_f_e_r__r_e_t_u_r_n and
  86.                               _k_e_y_s_y_m__r_e_t_u_r_n are not modified and the
  87.                               function returns a value of 0.
  88.  
  89.                     XXXXLLLLooooooookkkkuuuuppppCCCChhhhaaaarrrrssss
  90.                               Some input characters were composed and
  91.                               returned in _b_u_f_f_e_r__r_e_t_u_r_n. The content
  92.                               of _k_e_y_s_y_m__r_e_t_u_r_nis not modified. The
  93.                               function returns the length of the
  94.                               string in bytes.
  95.  
  96.                     XXXXLLLLooooooookkkkuuuuppppKKKKeeeeyyyyssssyyyymmmm
  97.                               A keysym value was returned instead of a
  98.                               string. The content of _b_u_f_f_e_r__r_e_t_u_r_n is
  99.                               not modified and the function returns a
  100.                               value of 0.
  101.  
  102.                     XXXXLLLLooooooookkkkuuuuppppBBBBooootttthhhh
  103.                               A keysym value and a string were
  104.                               returned. The keysym value may not
  105.                               necessarily correspond to the string
  106.                               returned. The function returns the
  107.                               length of the string in bytes.
  108.  
  109.      RRRREEEETTTTUUUURRRRNNNN
  110.           Return values depend on the status returned by the function.
  111.           Refer to the description of status values above.
  112.  
  113.      RRRREEEELLLLAAAATTTTEEEEDDDD
  114.           XXXXmmmmIIIImmmmGGGGeeeettttXXXXIIIIMMMM(3), XXXXmmmmIIIImmmmGGGGeeeettttXXXXIIIICCCC(3), XXXXmmmmIIIImmmmRRRReeeeggggiiiisssstttteeeerrrr(3),
  115.           XXXXmmmmIIIImmmmSSSSeeeettttVVVVaaaalllluuuueeeessss(3), and XXXXmmmmIIIImmmmUUUUnnnnrrrreeeeggggiiiisssstttteeeerrrr(3).
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.